Crate sway_core

Re-exports

pub use semantic_analysis::TypedDeclaration;

pub use crate::parse_tree::Declaration;

pub use crate::parse_tree::*;

pub use error::CompileError;

pub use error::CompileResult;

pub use error::CompileWarning;

Modules

constants

Configurable yet nonchanging constants for the compiler.

error

Tools related to handling/recovering from Sway compile errors and reporting them to the user.

parse_tree

Contains all the code related to parsing Sway source code.

semantic_analysis

Type checking for Sway.

source_map

type_engine

types

Contains post-type-engine resolved types.

Structs

AbstractInstructionSet

An AbstractInstructionSet is a set of instructions that use entirely virtual registers and excessive moves, with the intention of later optimizing it.

AstNode

A single AstNode represents a node in the parse tree. Note that AstNode is a recursive type and can contain other AstNode, thus populating the tree.

BuildConfig

Configuration for the overall build and compilation process.

Namespace

A namespace represents all items that exist either via declaration or importing.

ParseTree

Represents some exportable information that results from compiling some Sway source code.

SwayParseTree

Represents a parsed, but not yet type-checked, Sway program. A Sway program can be either a contract, script, predicate, or it can be a library to be imported into one of the aforementioned program types.

SwayParser

Represents the high level language parser generated by pest. Rule is also generated here by pest.

TypedFunctionDeclaration

UseStatement

A UseStatement is a statement that imports something from a module into the local namespace.

WhileLoop

A parsed while loop. Contains the condition, which is defined from an Expression, and the body from a CodeBlock.

Enums

AstNodeContent

Represents the various structures that constitute a Sway program.

BytecodeCompilationResult

Represents the result of compiling Sway code via compile_to_bytecode. Contains the compiled bytecode in byte form, or resulting errors, and any warnings generated.

CompilationResult

Represents the result of compiling Sway code via compile_to_asm. Contains the compiled assets or resulting errors, and any warnings generated.

CompileAstResult

Expression

Represents a parsed, but not yet type checked, Expression.

FinalizedAsm

Represents an ASM set which has had register allocation, jump elimination, and optimization applied to it

Rule

SwayAsmSet

The SwayAsmSet contains either a contract ABI and corresponding ASM, a script’s main function’s ASM, or a predicate’s main function’s ASM. ASM is never generated for libraries, as that happens when the library itself is imported.

TreeType

Represents the different variants of the AST.

TypeInfo

Type information without an associated value, used for type inferencing and definition.

TypedParseTree

Traits

NamespaceWrapper

Functions

asm_to_bytecode

Given a CompilationResult containing the assembly (opcodes), compile to a BytecodeCompilationResult which contains the asm in bytecode form.

ast_to_asm

Given an AST compilation result, compile to a CompilationResult which contains the asm in opcode form (not raw bytes/bytecode).

compile_to_asm

Given input Sway source code, compile to a CompilationResult which contains the asm in opcode form (not raw bytes/bytecode).

compile_to_ast

compile_to_bytecode

Given input Sway source code, compile to a BytecodeCompilationResult which contains the asm in bytecode form.

create_module

Create a new module (Namespace), insert it into the arena, and get its id back.

extract_keyword

If a given Rule exists in the input text, return that string trimmed. Otherwise, return None. This is typically used to find keywords.

parse

Given an input Arc<str> and an optional BuildConfig, parse the input into a SwayParseTree.

retrieve_module

Given a NamespaceRef, get a clone of the actual Namespace it refers to.

Type Definitions

NamespaceRef